<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/pico/aon_timer.h File Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('aon__timer_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">aon_timer.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
<code>#include &lt;time.h&gt;</code><br />
<code>#include &quot;<a class="el" href="datetime_8h_source.html">pico/util/datetime.h</a>&quot;</code><br />
<code>#include &quot;hardware/regs/intctrl.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for aon_timer.h:</div>
<div class="dyncontent">
<div class="center"><img src="aon__timer_8h__incl.png" border="0" usemap="#ainclude_2pico_2aon__timer_8h" alt=""/></div>
<map name="ainclude_2pico_2aon__timer_8h" id="ainclude_2pico_2aon__timer_8h">
<area shape="rect" title=" " alt="" coords="1366,5,1547,32"/>
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="1090,155,1151,181"/>
<area shape="rect" title=" " alt="" coords="1481,155,1545,181"/>
<area shape="rect" href="datetime_8h.html" title=" " alt="" coords="1326,80,1475,107"/>
<area shape="rect" title=" " alt="" coords="1551,80,1720,107"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="598,393,699,420"/>
<area shape="rect" title=" " alt="" coords="1064,237,1177,263"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="1202,237,1306,263"/>
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="543,237,664,263"/>
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="893,237,988,263"/>
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="444,468,549,495"/>
<area shape="rect" title=" " alt="" coords="513,543,595,569"/>
<area shape="rect" title=" " alt="" coords="649,468,720,495"/>
<area shape="rect" title=" " alt="" coords="745,468,819,495"/>
<area shape="rect" title=" " alt="" coords="1172,319,1336,345"/>
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="10,319,191,345"/>
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="215,319,394,345"/>
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="418,319,578,345"/>
<area shape="rect" title=" " alt="" coords="602,319,813,345"/>
<area shape="rect" title=" " alt="" coords="837,319,988,345"/>
<area shape="rect" title=" " alt="" coords="5,393,196,420"/>
<area shape="rect" href="rp2__common_2pico__clib__interface_2include_2llvm__libc_2sys_2time_8h_source.html" title=" " alt="" coords="1366,155,1457,181"/>
<area shape="rect" title=" " alt="" coords="1516,237,1683,263"/>
<area shape="rect" title=" " alt="" coords="1707,237,1886,263"/>
<area shape="rect" title=" " alt="" coords="1331,229,1492,271"/>
</map>
</div>
</div>
<p><a href="aon__timer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9f54d081a58f284678b04e910e11842b"><td class="memItemLeft" align="right" valign="top"><a id="a9f54d081a58f284678b04e910e11842b" name="a9f54d081a58f284678b04e910e11842b"></a>
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_alarm_handler_t</b>) (void)</td></tr>
<tr class="separator:a9f54d081a58f284678b04e910e11842b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga32e4d69ae8c5b2048af84cf706b8b997">aon_timer_start_with_timeofday</a> (void)</td></tr>
<tr class="memdesc:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the result from the gettimeofday() function as the current time.  <a href="group__pico__aon__timer.html#ga32e4d69ae8c5b2048af84cf706b8b997">More...</a><br /></td></tr>
<tr class="separator:ga32e4d69ae8c5b2048af84cf706b8b997"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga1d9876f6ebad5960e8d7928b87d6b8ca">aon_timer_start</a> (const struct timespec *ts)</td></tr>
<tr class="memdesc:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified timespec as the current time.  <a href="group__pico__aon__timer.html#ga1d9876f6ebad5960e8d7928b87d6b8ca">More...</a><br /></td></tr>
<tr class="separator:ga1d9876f6ebad5960e8d7928b87d6b8ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25e4ac9d9553d35646af544277ca9e4e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga25e4ac9d9553d35646af544277ca9e4e">aon_timer_start_calendar</a> (const struct tm *tm)</td></tr>
<tr class="memdesc:ga25e4ac9d9553d35646af544277ca9e4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the AON timer running using the specified calendar date/time as the current time.  <a href="group__pico__aon__timer.html#ga25e4ac9d9553d35646af544277ca9e4e">More...</a><br /></td></tr>
<tr class="separator:ga25e4ac9d9553d35646af544277ca9e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_stop</b> (void)</td></tr>
<tr class="memdesc:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the AON timer. <br /></td></tr>
<tr class="separator:gaad98990deb5ce061e3cac6ef7cc69fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gaa9503489fbd3c6afc1d4e67e3c3ae1dc">aon_timer_set_time</a> (const struct timespec *ts)</td></tr>
<tr class="memdesc:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current time of the AON timer.  <a href="group__pico__aon__timer.html#gaa9503489fbd3c6afc1d4e67e3c3ae1dc">More...</a><br /></td></tr>
<tr class="separator:gaa9503489fbd3c6afc1d4e67e3c3ae1dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3b326fe02569768b09f37080f0d85e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gae3b326fe02569768b09f37080f0d85e3">aon_timer_set_time_calendar</a> (const struct tm *tm)</td></tr>
<tr class="memdesc:gae3b326fe02569768b09f37080f0d85e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current time of the AON timer to the given calendar date/time.  <a href="group__pico__aon__timer.html#gae3b326fe02569768b09f37080f0d85e3">More...</a><br /></td></tr>
<tr class="separator:gae3b326fe02569768b09f37080f0d85e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48246c7cd89f2f599f9d3405d1b62185"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga48246c7cd89f2f599f9d3405d1b62185">aon_timer_get_time</a> (struct timespec *ts)</td></tr>
<tr class="memdesc:ga48246c7cd89f2f599f9d3405d1b62185"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer.  <a href="group__pico__aon__timer.html#ga48246c7cd89f2f599f9d3405d1b62185">More...</a><br /></td></tr>
<tr class="separator:ga48246c7cd89f2f599f9d3405d1b62185"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga5ed3f772e4fcab66dadb7654f1fa47ef">aon_timer_get_time_calendar</a> (struct tm *tm)</td></tr>
<tr class="memdesc:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time of the AON timer as a calendar date/time.  <a href="group__pico__aon__timer.html#ga5ed3f772e4fcab66dadb7654f1fa47ef">More...</a><br /></td></tr>
<tr class="separator:ga5ed3f772e4fcab66dadb7654f1fa47ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">aon_timer_get_resolution</a> (struct timespec *ts)</td></tr>
<tr class="memdesc:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the resolution of the AON timer.  <a href="group__pico__aon__timer.html#ga6e17d6adde0e3b25c70c04970116ccb8">More...</a><br /></td></tr>
<tr class="separator:ga6e17d6adde0e3b25c70c04970116ccb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39dab1da58c2f8178024b233e335d059"><td class="memItemLeft" align="right" valign="top">aon_timer_alarm_handler_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">aon_timer_enable_alarm</a> (const struct timespec *ts, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power)</td></tr>
<tr class="memdesc:ga39dab1da58c2f8178024b233e335d059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specified time.  <a href="group__pico__aon__timer.html#ga39dab1da58c2f8178024b233e335d059">More...</a><br /></td></tr>
<tr class="separator:ga39dab1da58c2f8178024b233e335d059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfecbe6df690a2a10194920ba7db8d3f"><td class="memItemLeft" align="right" valign="top">aon_timer_alarm_handler_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#gabfecbe6df690a2a10194920ba7db8d3f">aon_timer_enable_alarm_calendar</a> (const struct tm *tm, aon_timer_alarm_handler_t handler, bool wakeup_from_low_power)</td></tr>
<tr class="memdesc:gabfecbe6df690a2a10194920ba7db8d3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an AON timer alarm for a specified calendar date/time.  <a href="group__pico__aon__timer.html#gabfecbe6df690a2a10194920ba7db8d3f">More...</a><br /></td></tr>
<tr class="separator:gabfecbe6df690a2a10194920ba7db8d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_disable_alarm</b> (void)</td></tr>
<tr class="memdesc:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any. <br /></td></tr>
<tr class="separator:ga20cda0289aab2eb5fda914704a1fc2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__aon__timer.html#ga134ec8ae2a5f2a9b29b9bc4fb6c87493">aon_timer_is_running</a> (void)</td></tr>
<tr class="memdesc:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the currently enabled AON timer alarm if any.  <a href="group__pico__aon__timer.html#ga134ec8ae2a5f2a9b29b9bc4fb6c87493">More...</a><br /></td></tr>
<tr class="separator:ga134ec8ae2a5f2a9b29b9bc4fb6c87493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acddc1af4b70e5d51c47bf7ca8a3e172e"><td class="memItemLeft" align="right" valign="top"><a id="acddc1af4b70e5d51c47bf7ca8a3e172e" name="acddc1af4b70e5d51c47bf7ca8a3e172e"></a>
static uint&#160;</td><td class="memItemRight" valign="bottom"><b>aon_timer_get_irq_num</b> (void)</td></tr>
<tr class="separator:acddc1af4b70e5d51c47bf7ca8a3e172e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>